<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: ConstMappingIteratorWrapper Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00060.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#pri-methods">Private Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">ConstMappingIteratorWrapper Class Reference<div class="ingroups"><a class="el" href="a00520.html">mappingDetails - mostly internal mapping classes</a></div></div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="ConstMappingIteratorWrapper" --><!-- doxytag: inherits="MappingIterator" -->
<p>Wraps an <a class="el" href="a00059.html" title="Defines an const iterator for a ConstMapping which is able to iterate over the Mapping.">ConstMappingIterator</a> into a <a class="el" href="a00137.html" title="Defines an iterator for a Mapping which is able to iterate over the Mapping.">MappingIterator</a> interface.  
 <a href="a00060.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00300_source.html">MappingUtils.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ConstMappingIteratorWrapper:</div>
<div class="dyncontent">
<div class="center"><img src="a00669.png" border="0" usemap="#ConstMappingIteratorWrapper_inherit__map" alt="Inheritance graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ConstMappingIteratorWrapper:</div>
<div class="dyncontent">
<div class="center"><img src="a00670.png" border="0" usemap="#ConstMappingIteratorWrapper_coll__map" alt="Collaboration graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="a00671.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10f8c5f502b9cd83e9a6fa2d85195184"></a><!-- doxytag: member="ConstMappingIteratorWrapper::ConstMappingIteratorWrapper" ref="a10f8c5f502b9cd83e9a6fa2d85195184" args="(ConstMappingIterator *it)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>ConstMappingIteratorWrapper</b> (<a class="el" href="a00059.html">ConstMappingIterator</a> *it)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a21f0afa0d6ffa165911fe5a19cfd032c">setValue</a> (argument_value_cref_t)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Changes the value of the <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a> at the current position.  <a href="#a21f0afa0d6ffa165911fe5a19cfd032c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a603cbcad1aa33945132a3b8e2cfb769e"></a><!-- doxytag: member="ConstMappingIteratorWrapper::getNextPosition" ref="a603cbcad1aa33945132a3b8e2cfb769e" args="() const " -->
virtual const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a603cbcad1aa33945132a3b8e2cfb769e">getNextPosition</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the position the next call to "next()" of this Iterator would iterate to. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a4864dc39a40cada6f4abde4fc6eea3b7">jumpTo</a> (const <a class="el" href="a00013.html">Argument</a> &amp;pos)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Lets the iterator point to the passed position.  <a href="#a4864dc39a40cada6f4abde4fc6eea3b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a6e3de2e2477083e963498675ed8b78b9">jumpToBegin</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Lets the iterator point to the begin of the mapping.  <a href="#a6e3de2e2477083e963498675ed8b78b9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab96b7f5eca4759cdeaad879512340b93"></a><!-- doxytag: member="ConstMappingIteratorWrapper::iterateTo" ref="ab96b7f5eca4759cdeaad879512340b93" args="(const Argument &amp;pos)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#ab96b7f5eca4759cdeaad879512340b93">iterateTo</a> (const <a class="el" href="a00013.html">Argument</a> &amp;pos)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterates to the specified position. This method should be used if the new position is near the current position. Furthermore the new position has to be compared bigger than the old position. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a01e885f408515be1170ce8af57de217b">next</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterates to the next position of the <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a>.  <a href="#a01e885f408515be1170ce8af57de217b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a4a4bb9cfd56c7013bf5bd4347fef3293">inRange</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the current position of the iterator is in range of the function.  <a href="#a4a4bb9cfd56c7013bf5bd4347fef3293"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab60f4f00ba7175122fe6afef43b7cfbc"></a><!-- doxytag: member="ConstMappingIteratorWrapper::hasNext" ref="ab60f4f00ba7175122fe6afef43b7cfbc" args="() const " -->
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#ab60f4f00ba7175122fe6afef43b7cfbc">hasNext</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the iterator has a next value it can iterate to on a call to "next()". <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed031f6f66b8c703523fc41b0a7c2107"></a><!-- doxytag: member="ConstMappingIteratorWrapper::getPosition" ref="aed031f6f66b8c703523fc41b0a7c2107" args="() const " -->
virtual const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#aed031f6f66b8c703523fc41b0a7c2107">getPosition</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current position of the iterator. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual argument_value_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a755c87e1eb464724fcc9e5908d25cfac">getValue</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the value of the <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a> at the current position.  <a href="#a755c87e1eb464724fcc9e5908d25cfac"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2d62428852c6cefb80bd08c3aa565ca"></a><!-- doxytag: member="ConstMappingIteratorWrapper::iterator" ref="af2d62428852c6cefb80bd08c3aa565ca" args="" -->
<a class="el" href="a00059.html">ConstMappingIterator</a> *const&#160;</td><td class="memItemRight" valign="bottom"><b>iterator</b></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a571c5696de74f8b7f362e474a823b17a"></a><!-- doxytag: member="ConstMappingIteratorWrapper::ConstMappingIteratorWrapper" ref="a571c5696de74f8b7f362e474a823b17a" args="(const ConstMappingIteratorWrapper &amp;)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#a571c5696de74f8b7f362e474a823b17a">ConstMappingIteratorWrapper</a> (const <a class="el" href="a00060.html">ConstMappingIteratorWrapper</a> &amp;)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor is not allowed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad176a83e7a1d1e5a1dbb8485d2240f6f"></a><!-- doxytag: member="ConstMappingIteratorWrapper::operator=" ref="ad176a83e7a1d1e5a1dbb8485d2240f6f" args="(const ConstMappingIteratorWrapper &amp;)" -->
<a class="el" href="a00060.html">ConstMappingIteratorWrapper</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00060.html#ad176a83e7a1d1e5a1dbb8485d2240f6f">operator=</a> (const <a class="el" href="a00060.html">ConstMappingIteratorWrapper</a> &amp;)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator is not allowed. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Wraps an <a class="el" href="a00059.html" title="Defines an const iterator for a ConstMapping which is able to iterate over the Mapping.">ConstMappingIterator</a> into a <a class="el" href="a00137.html" title="Defines an iterator for a Mapping which is able to iterate over the Mapping.">MappingIterator</a> interface. </p>
<p>Assumes that "setValue()" of the <a class="el" href="a00137.html" title="Defines an iterator for a Mapping which is able to iterate over the Mapping.">MappingIterator</a> interface will never be called.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Karl Wessel </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a755c87e1eb464724fcc9e5908d25cfac"></a><!-- doxytag: member="ConstMappingIteratorWrapper::getValue" ref="a755c87e1eb464724fcc9e5908d25cfac" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual argument_value_t ConstMappingIteratorWrapper::getValue </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the value of the <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a> at the current position. </p>
<p>The complexity of this method should be constant for every implementation. </p>

<p>Implements <a class="el" href="a00059.html#ad4419c259e747867f003d07d62d4259f">ConstMappingIterator</a>.</p>
<div class="fragment"><pre class="fragment">{ <span class="keywordflow">return</span> iterator-&gt;<a class="code" href="a00059.html#ad4419c259e747867f003d07d62d4259f" title="Returns the value of the Mapping at the current position.">getValue</a>(); }
</pre></div>
</div>
</div>
<a class="anchor" id="a4a4bb9cfd56c7013bf5bd4347fef3293"></a><!-- doxytag: member="ConstMappingIteratorWrapper::inRange" ref="a4a4bb9cfd56c7013bf5bd4347fef3293" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool ConstMappingIteratorWrapper::inRange </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns true if the current position of the iterator is in range of the function. </p>
<p>This method should be used as end-condition when iterating over the function with the "next()" method. </p>

<p>Implements <a class="el" href="a00059.html#a4a6348a453418da95978e570fec046fc">ConstMappingIterator</a>.</p>
<div class="fragment"><pre class="fragment">{ <span class="keywordflow">return</span> iterator-&gt;<a class="code" href="a00059.html#a4a6348a453418da95978e570fec046fc" title="Returns true if the current position of the iterator is in range of the function.">inRange</a>(); }
</pre></div>
</div>
</div>
<a class="anchor" id="a4864dc39a40cada6f4abde4fc6eea3b7"></a><!-- doxytag: member="ConstMappingIteratorWrapper::jumpTo" ref="a4864dc39a40cada6f4abde4fc6eea3b7" args="(const Argument &amp;pos)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ConstMappingIteratorWrapper::jumpTo </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td>
          <td class="paramname"><em>pos</em></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Lets the iterator point to the passed position. </p>
<p>The passed new position can be at arbitrary places. </p>

<p>Implements <a class="el" href="a00059.html#ae3cdbe2115d0e87af0da549b675f2bf8">ConstMappingIterator</a>.</p>
<div class="fragment"><pre class="fragment">{ iterator-&gt;<a class="code" href="a00059.html#ae3cdbe2115d0e87af0da549b675f2bf8" title="Lets the iterator point to the passed position.">jumpTo</a>(pos); }
</pre></div>
</div>
</div>
<a class="anchor" id="a6e3de2e2477083e963498675ed8b78b9"></a><!-- doxytag: member="ConstMappingIteratorWrapper::jumpToBegin" ref="a6e3de2e2477083e963498675ed8b78b9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ConstMappingIteratorWrapper::jumpToBegin </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Lets the iterator point to the begin of the mapping. </p>
<p>The beginning of the mapping depends on the implementation. With an implementation based on a number of key-entries, this could be the key entry with the smallest position (see class <a class="el" href="a00013.html" title="Defines an argument for a mapping.">Argument</a> for ordering of positions). </p>

<p>Implements <a class="el" href="a00059.html#a6b6af19266855c21ce3e3449de3f0d6f">ConstMappingIterator</a>.</p>
<div class="fragment"><pre class="fragment">{ iterator-&gt;<a class="code" href="a00059.html#a6b6af19266855c21ce3e3449de3f0d6f" title="Lets the iterator point to the begin of the mapping.">jumpToBegin</a>(); }
</pre></div>
</div>
</div>
<a class="anchor" id="a01e885f408515be1170ce8af57de217b"></a><!-- doxytag: member="ConstMappingIteratorWrapper::next" ref="a01e885f408515be1170ce8af57de217b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ConstMappingIteratorWrapper::next </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Iterates to the next position of the <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a>. </p>
<p>The next position depends on the implementation of the <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a>. With an implementation based on a number of key-entries this probably would be the next bigger key-entry. </p>

<p>Implements <a class="el" href="a00059.html#afdafa6870cd19b3d35674a7bc777585d">ConstMappingIterator</a>.</p>
<div class="fragment"><pre class="fragment">{ iterator-&gt;<a class="code" href="a00059.html#afdafa6870cd19b3d35674a7bc777585d" title="Iterates to the next position of the Mapping.">next</a>(); }
</pre></div>
</div>
</div>
<a class="anchor" id="a21f0afa0d6ffa165911fe5a19cfd032c"></a><!-- doxytag: member="ConstMappingIteratorWrapper::setValue" ref="a21f0afa0d6ffa165911fe5a19cfd032c" args="(argument_value_cref_t)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ConstMappingIteratorWrapper::setValue </td>
          <td>(</td>
          <td class="paramtype">argument_value_cref_t&#160;</td>
          <td class="paramname"><em>value</em></td><td>)</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Changes the value of the <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a> at the current position. </p>
<p>Implementations of this method should provide constant complexity. </p>

<p>Implements <a class="el" href="a00137.html#a68c80b10de257d7cfd68f49bfd6a2cbe">MappingIterator</a>.</p>
<div class="fragment"><pre class="fragment">{ assert(<span class="keyword">false</span>); }
</pre></div>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>D:/Projects/MiXiM/extsrc/mixim/src/base/phyLayer/<a class="el" href="a00300_source.html">MappingUtils.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="a00060.html">ConstMappingIteratorWrapper</a>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:31 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
